/*
 * Copyright (c) 2008-2016 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.haulmont.cuba.gui.components.mainwindow;

import com.haulmont.cuba.gui.components.Component;
import com.haulmont.cuba.security.entity.User;

import java.util.function.Function;

public interface UserIndicator extends Component.BelongToFrame {

    String NAME = "userIndicator";

    void refreshUserSubstitutions();

    /**
     * Assign a formatter that change user name caption.
     *
     * @param userNameFormatter formatter to be executed.
     */
    void setUserNameFormatter(Function<? super User, String> userNameFormatter);

    /**
     * @return formatter that is used or null.
     */
    Function<User, String> getUserNameFormatter();
}